Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editorial: update the standard for the WHATWG move #193

Merged
merged 11 commits into from
Oct 20, 2023
Merged

Conversation

domenic
Copy link
Member

@domenic domenic commented Oct 17, 2023

  • Update repository files using whatwg/spec-factory.
  • Use the WHATWG template.
  • Add an Acknowledgments section and IPR statement.
  • Sentence-case all headings.
  • Add missing example IDs and suppress a warning about "optional" being used in an example.
  • Minor fixes to the introductory example to work well with WHATWG styling.
  • Fix some invalid HTML, double-"the" typos, and usage of "and/or" disallowed by the linter.
  • Reword some disallowed uses of RFC 2119 keywords.

Part of #190. See also whatwg/sg#215.

I'd like editor review and also @annevk review if possible.


💥 Error: 400 Bad Request 💥

PR Preview failed to build. (Last tried on Oct 18, 2023, 5:54 AM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

🚨 CSS Spec Preprocessor - CSS Spec Preprocessor is the web service used to build Bikeshed specs.

🔗 Related URL

Error running preprocessor, returned code: 2.
FATAL ERROR: Found unmatched text macro [COMMIT-SHA]. Correct the macro, or escape it with a leading backslash.
 ✘  Did not generate, due to errors exceeding the allowed error level.

If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please file an issue.

spec.bs Show resolved Hide resolved
@domenic
Copy link
Member Author

domenic commented Oct 17, 2023

The build will fail until we run spec-factory to update the Makefile, etc.; that will be a separate pull request. (Which we can merge before this one.)

spec.bs Outdated Show resolved Hide resolved
@annevk
Copy link
Member

annevk commented Oct 17, 2023

Running spec-factory would be good because then PR Preview works and we can see what the document ends up looking like, right?

@domenic
Copy link
Member Author

domenic commented Oct 17, 2023

Yeah, I'll try to land that first, but I think that depends on db.json.

@jeremyroman
Copy link
Collaborator

Looks fine on inspection, but a preview would be nice. :)

* Use the WHATWG template.
* Add an Acknowledgments section and IPR statement.
* Sentence-case all headings.
* Add missing example IDs and suppress a warning about "optional" being used in an example.
* Minor fixes to the introductory example to work well with WHATWG styling.
@domenic
Copy link
Member Author

domenic commented Oct 18, 2023

I think a preview is not possible because PR preview is using the old config file against the new spec, or something like that, and thus fails the whole process when it can't generate the old spec in order to create diffs.

In lieu of that I've set up a preview here: https://boom-bath.glitch.me/urlpattern-preview.html

Editor review especially appreciated for changes to spec.bs.

@@ -426,7 +357,7 @@ A [=component=] has an associated <dfn for=component>group name list</dfn>, a [=
1. If |options|'s [=options/ignore case=] is true then set |flags| to "`vi`".
1. Otherwise set |flags| to "`v`"
1. Let |regular expression| be [$RegExpCreate$](|regular expression string|, |flags|). If this throws an exception, catch it, and throw a {{TypeError}}.
<p class="note allow-2119">The specification uses regular expressions to perform all matching, but this is not required. Implementations are free to perform matching directly against the [=/part list=] when possible; e.g. when there are no custom regexp matching groups. If there are custom regular expressions, however, its important that they should be immediately evaluated in the [=compile a component=] algorithm so an error can be thrown if they are invalid.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should seems to be just removed. Don't we need an alternative word?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the careful review! I think it is OK in this case actually. "It is important that they be (verb phrase)" is acceptable.

@domenic domenic merged commit dabcf9f into main Oct 20, 2023
1 check passed
@domenic domenic deleted the update-spec branch October 20, 2023 05:32
@domenic
Copy link
Member Author

domenic commented Oct 20, 2023

The standard is live! https://urlpattern.spec.whatwg.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants